<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>SpELCacheKeyGenerator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright 2010-2011 Nicholas Blair, Eric Dalquist</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> com.googlecode.ehcache.annotations.key;
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.util.Collections;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.util.Map.Entry;
<a class="jxr_linenumber" name="24" href="#24">24</a>  
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.aopalliance.intercept.MethodInvocation;
<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.BeansException;
<a class="jxr_linenumber" name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.MutablePropertyValues;
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.BeanFactory;
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.BeanFactoryAware;
<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.InitializingBean;
<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.support.AbstractBeanDefinition;
<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.support.DefaultListableBeanFactory;
<a class="jxr_linenumber" name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.springframework.beans.factory.support.GenericBeanDefinition;
<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.springframework.context.expression.BeanFactoryResolver;
<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.springframework.core.convert.TypeDescriptor;
<a class="jxr_linenumber" name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.AccessException;
<a class="jxr_linenumber" name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.EvaluationContext;
<a class="jxr_linenumber" name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.Expression;
<a class="jxr_linenumber" name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.ExpressionParser;
<a class="jxr_linenumber" name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.MethodExecutor;
<a class="jxr_linenumber" name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.MethodResolver;
<a class="jxr_linenumber" name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.TypedValue;
<a class="jxr_linenumber" name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.spel.standard.SpelExpressionParser;
<a class="jxr_linenumber" name="44" href="#44">44</a>  <strong class="jxr_keyword">import</strong> org.springframework.expression.spel.support.StandardEvaluationContext;
<a class="jxr_linenumber" name="45" href="#45">45</a>  
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * Spring Expression Language cache key generator.</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * Usage: &lt;pre&gt;@Property(key="expression" value="args[ARGUMENT_INDEX].propertyOfModel"&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * @Cacheable(cacheName = "testCache", </em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> *            keyGenerator = @KeyGenerator(name = KEY_GENERATOR, </em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> *                                         properties = @Property(name = "expression", value = "args[0].id")))</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * 	public String get(MyModel model) {</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * The SpEL {@link EvaluationContext} has three variables registered on it:</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> *  &lt;li&gt;&lt;b&gt;#invocation&lt;/b&gt; - The {@link MethodInvocation} that is being cached&lt;/li&gt;</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> *  &lt;li&gt;&lt;b&gt;#args&lt;/b&gt; - Shortcut to the Object[] returned by {@link MethodInvocation#getArguments()}&lt;/li&gt;</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> *  &lt;li&gt;&lt;b&gt;#key&lt;/b&gt; - Key generation object where other {@link CacheKeyGenerator} implementation are registered as functions. No matter</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> *      what is set via {@link #setKeyGenerators(Map)} the following functions will always be available:</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> *      &lt;ul&gt;</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.hash&lt;/b&gt; - {@link HashCodeCacheKeyGenerator#generateKey(Object...)}&lt;/li&gt;</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.hashR&lt;/b&gt; - {@link HashCodeCacheKeyGenerator#generateKey(Object...)} with {@link HashCodeCacheKeyGenerator#setUseReflection(boolean)} set to true&lt;/li&gt;</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.string&lt;/b&gt; - {@link StringCacheKeyGenerator#generateKey(Object...)}&lt;/li&gt;</em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.stringR&lt;/b&gt; - {@link StringCacheKeyGenerator#generateKey(Object...)} with {@link StringCacheKeyGenerator#setUseReflection(boolean)} set to true&lt;/li&gt;</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.list&lt;/b&gt; - {@link ListCacheKeyGenerator#generateKey(Object...)}&lt;/li&gt;</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.listR&lt;/b&gt; - {@link ListCacheKeyGenerator#generateKey(Object...)} with {@link ListCacheKeyGenerator#setUseReflection(boolean)} set to true&lt;/li&gt;</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.digest&lt;/b&gt; - {@link MessageDigestCacheKeyGenerator#generateKey(Object...)}&lt;/li&gt;</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment"> *        &lt;li&gt;&lt;b&gt;#key.digestR&lt;/b&gt; - {@link MessageDigestCacheKeyGenerator#generateKey(Object...)} with {@link MessageDigestCacheKeyGenerator#setUseReflection(boolean)} set to true&lt;/li&gt;</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment"> *      &lt;/ul&gt;</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment"> * &lt;/ul&gt; </em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment"> * @author Timothy Freyne</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">SpELCacheKeyGenerator</a> <strong class="jxr_keyword">implements</strong> CacheKeyGenerator&lt;Serializable&gt;, BeanFactoryAware, InitializingBean, <a href="../../../../../com/googlecode/ehcache/annotations/key/ReflectionHelperAware.html">ReflectionHelperAware</a> {
<a class="jxr_linenumber" name="78" href="#78">78</a>      
<a class="jxr_linenumber" name="79" href="#79">79</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Map&lt;String, Class&lt;?&gt;&gt; DEFAULT_KEY_GENERATORS;
<a class="jxr_linenumber" name="80" href="#80">80</a>      <strong class="jxr_keyword">static</strong> {
<a class="jxr_linenumber" name="81" href="#81">81</a>          <strong class="jxr_keyword">final</strong> LinkedHashMap&lt;String, Class&lt;?&gt;&gt; keyGenerators = <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;String, Class&lt;?&gt;&gt;();
<a class="jxr_linenumber" name="82" href="#82">82</a>          
<a class="jxr_linenumber" name="83" href="#83">83</a>          keyGenerators.put(<span class="jxr_string">"hash"</span>, HashCodeCacheKeyGenerator.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="84" href="#84">84</a>          keyGenerators.put(<span class="jxr_string">"string"</span>, StringCacheKeyGenerator.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="85" href="#85">85</a>          keyGenerators.put(<span class="jxr_string">"list"</span>, ListCacheKeyGenerator.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="86" href="#86">86</a>          keyGenerators.put(<span class="jxr_string">"digest"</span>, MessageDigestCacheKeyGenerator.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="87" href="#87">87</a>          
<a class="jxr_linenumber" name="88" href="#88">88</a>          DEFAULT_KEY_GENERATORS = Collections.unmodifiableMap(keyGenerators);
<a class="jxr_linenumber" name="89" href="#89">89</a>      }
<a class="jxr_linenumber" name="90" href="#90">90</a>      
<a class="jxr_linenumber" name="91" href="#91">91</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ExpressionParser expressionParser = <strong class="jxr_keyword">new</strong> SpelExpressionParser();
<a class="jxr_linenumber" name="92" href="#92">92</a>  
<a class="jxr_linenumber" name="93" href="#93">93</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">KeyGeneratorMethodResolver</a> methodResolver = <strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">KeyGeneratorMethodResolver</a>();
<a class="jxr_linenumber" name="94" href="#94">94</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Object keyCallbackObject = <strong class="jxr_keyword">new</strong> Object();
<a class="jxr_linenumber" name="95" href="#95">95</a>      
<a class="jxr_linenumber" name="96" href="#96">96</a>      <em class="jxr_comment">//Used to create auto-registered key generators for function calls</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>      <strong class="jxr_keyword">private</strong> DefaultListableBeanFactory cacheKeyBeanFactory;
<a class="jxr_linenumber" name="98" href="#98">98</a>      <strong class="jxr_keyword">private</strong> Map&lt;String, CacheKeyGenerator&lt;Serializable&gt;&gt; registeredKeyGenerators;
<a class="jxr_linenumber" name="99" href="#99">99</a>      <strong class="jxr_keyword">private</strong> Map&lt;String, MethodExecutor&gt; keyGeneratorMethodExecutors;
<a class="jxr_linenumber" name="100" href="#100">100</a> 	<strong class="jxr_keyword">private</strong> Expression expression;
<a class="jxr_linenumber" name="101" href="#101">101</a> 	<strong class="jxr_keyword">private</strong> BeanFactory beanFactory;
<a class="jxr_linenumber" name="102" href="#102">102</a> 	<strong class="jxr_keyword">private</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/ReflectionHelper.html">ReflectionHelper</a> reflectionHelper;
<a class="jxr_linenumber" name="103" href="#103">103</a> 
<a class="jxr_linenumber" name="104" href="#104">104</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">	 * The SpEL Expression evaluated to generate the cache key. The expression must return a {@link Serializable} object</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> 	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExpression(String expression) {
<a class="jxr_linenumber" name="108" href="#108">108</a> 	    <strong class="jxr_keyword">this</strong>.expression = parseExpression(expression);
<a class="jxr_linenumber" name="109" href="#109">109</a> 	}
<a class="jxr_linenumber" name="110" href="#110">110</a>     
<a class="jxr_linenumber" name="111" href="#111">111</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * A Map of {@link CacheKeyGenerator}s to register as functions on the #key object in the SpEL {@link EvaluationContext}.</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * The map key is used as the function name on the #key object.</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="115" href="#115">115</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeyGenerators(Map&lt;String, CacheKeyGenerator&lt;Serializable&gt;&gt; keyGenerators) {
<a class="jxr_linenumber" name="116" href="#116">116</a>         <strong class="jxr_keyword">this</strong>.registeredKeyGenerators = <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;String, CacheKeyGenerator&lt;Serializable&gt;&gt;(keyGenerators);
<a class="jxr_linenumber" name="117" href="#117">117</a>     }
<a class="jxr_linenumber" name="118" href="#118">118</a> 	
<a class="jxr_linenumber" name="119" href="#119">119</a> 	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReflectionHelper(<a href="../../../../../com/googlecode/ehcache/annotations/key/ReflectionHelper.html">ReflectionHelper</a> reflectionHelper) {
<a class="jxr_linenumber" name="120" href="#120">120</a>         <strong class="jxr_keyword">this</strong>.reflectionHelper = reflectionHelper;
<a class="jxr_linenumber" name="121" href="#121">121</a>     }
<a class="jxr_linenumber" name="122" href="#122">122</a> 	
<a class="jxr_linenumber" name="123" href="#123">123</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setBeanFactory(BeanFactory beanFactory) <strong class="jxr_keyword">throws</strong> BeansException {
<a class="jxr_linenumber" name="124" href="#124">124</a>         <strong class="jxr_keyword">this</strong>.beanFactory = beanFactory;
<a class="jxr_linenumber" name="125" href="#125">125</a>         <strong class="jxr_keyword">this</strong>.cacheKeyBeanFactory = <strong class="jxr_keyword">new</strong> DefaultListableBeanFactory(<strong class="jxr_keyword">this</strong>.beanFactory);
<a class="jxr_linenumber" name="126" href="#126">126</a>     }
<a class="jxr_linenumber" name="127" href="#127">127</a> 
<a class="jxr_linenumber" name="128" href="#128">128</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> afterPropertiesSet() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="129" href="#129">129</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.registeredKeyGenerators == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="130" href="#130">130</a>             <strong class="jxr_keyword">this</strong>.registeredKeyGenerators = <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;String, CacheKeyGenerator&lt;Serializable&gt;&gt;();
<a class="jxr_linenumber" name="131" href="#131">131</a>         }
<a class="jxr_linenumber" name="132" href="#132">132</a>         
<a class="jxr_linenumber" name="133" href="#133">133</a>         <em class="jxr_comment">//Make sure the default generators are all configured</em>
<a class="jxr_linenumber" name="134" href="#134">134</a>         <strong class="jxr_keyword">this</strong>.registerDefaultKeyGenerators();
<a class="jxr_linenumber" name="135" href="#135">135</a>         
<a class="jxr_linenumber" name="136" href="#136">136</a>         <strong class="jxr_keyword">this</strong>.createKeyGeneratorMethodExecutors();
<a class="jxr_linenumber" name="137" href="#137">137</a>     }
<a class="jxr_linenumber" name="138" href="#138">138</a> 
<a class="jxr_linenumber" name="139" href="#139">139</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * Check that all {@link CacheKeyGenerator}s defined in the {@link #DEFAULT_KEY_GENERATORS} Map are registered</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * in the SpEL context as key functions.</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="143" href="#143">143</a>     @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="144" href="#144">144</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> registerDefaultKeyGenerators() {
<a class="jxr_linenumber" name="145" href="#145">145</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Entry&lt;String, Class&lt;?&gt;&gt; defaultGeneratorEntry : DEFAULT_KEY_GENERATORS.entrySet()) {
<a class="jxr_linenumber" name="146" href="#146">146</a>             <strong class="jxr_keyword">final</strong> String name = defaultGeneratorEntry.getKey();
<a class="jxr_linenumber" name="147" href="#147">147</a>             <strong class="jxr_keyword">final</strong> Class&lt;CacheKeyGenerator&lt;Serializable&gt;&gt; keyGeneratorClass = (Class&lt;CacheKeyGenerator&lt;Serializable&gt;&gt;)defaultGeneratorEntry.getValue();
<a class="jxr_linenumber" name="148" href="#148">148</a>             
<a class="jxr_linenumber" name="149" href="#149">149</a>             <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.registeredKeyGenerators.containsKey(name)) {
<a class="jxr_linenumber" name="150" href="#150">150</a>                 <strong class="jxr_keyword">final</strong> MutablePropertyValues properties = <strong class="jxr_keyword">new</strong> MutablePropertyValues();
<a class="jxr_linenumber" name="151" href="#151">151</a>                 <strong class="jxr_keyword">final</strong> CacheKeyGenerator&lt;Serializable&gt; keyGenerator = createKeyGenerator(name, keyGeneratorClass, properties);
<a class="jxr_linenumber" name="152" href="#152">152</a>                 <strong class="jxr_keyword">this</strong>.registeredKeyGenerators.put(name, keyGenerator);
<a class="jxr_linenumber" name="153" href="#153">153</a>             }
<a class="jxr_linenumber" name="154" href="#154">154</a>             <strong class="jxr_keyword">final</strong> String reflectionName = name + <span class="jxr_string">"R"</span>;
<a class="jxr_linenumber" name="155" href="#155">155</a>             <strong class="jxr_keyword">if</strong> (keyGeneratorClass.isAssignableFrom(AbstractDeepCacheKeyGenerator.<strong class="jxr_keyword">class</strong>) &amp;&amp; !<strong class="jxr_keyword">this</strong>.registeredKeyGenerators.containsKey(reflectionName)) {
<a class="jxr_linenumber" name="156" href="#156">156</a>                 <strong class="jxr_keyword">final</strong> MutablePropertyValues properties = <strong class="jxr_keyword">new</strong> MutablePropertyValues();
<a class="jxr_linenumber" name="157" href="#157">157</a>                 properties.addPropertyValue(<span class="jxr_string">"useReflection"</span>, <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="158" href="#158">158</a>                 <strong class="jxr_keyword">final</strong> CacheKeyGenerator&lt;Serializable&gt; keyGenerator = createKeyGenerator(reflectionName, keyGeneratorClass, properties);
<a class="jxr_linenumber" name="159" href="#159">159</a>                 <strong class="jxr_keyword">this</strong>.registeredKeyGenerators.put(reflectionName, keyGenerator);
<a class="jxr_linenumber" name="160" href="#160">160</a>             }
<a class="jxr_linenumber" name="161" href="#161">161</a>         }
<a class="jxr_linenumber" name="162" href="#162">162</a>     }
<a class="jxr_linenumber" name="163" href="#163">163</a>     
<a class="jxr_linenumber" name="164" href="#164">164</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * Add {@link MethodExecutor} wrapper around all of the registered {@link CacheKeyGenerator}s to avoid</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">     * creating the wrappers on every use.</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="168" href="#168">168</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> createKeyGeneratorMethodExecutors() {
<a class="jxr_linenumber" name="169" href="#169">169</a>         <strong class="jxr_keyword">this</strong>.keyGeneratorMethodExecutors = <strong class="jxr_keyword">new</strong> LinkedHashMap&lt;String, MethodExecutor&gt;(<strong class="jxr_keyword">this</strong>.registeredKeyGenerators.size());
<a class="jxr_linenumber" name="170" href="#170">170</a>         
<a class="jxr_linenumber" name="171" href="#171">171</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Entry&lt;String, CacheKeyGenerator&lt;Serializable&gt;&gt; keyGeneratorEntry : <strong class="jxr_keyword">this</strong>.registeredKeyGenerators.entrySet()) {
<a class="jxr_linenumber" name="172" href="#172">172</a>             <strong class="jxr_keyword">final</strong> String name = keyGeneratorEntry.getKey();
<a class="jxr_linenumber" name="173" href="#173">173</a>             <strong class="jxr_keyword">final</strong> CacheKeyGenerator&lt;Serializable&gt; keyGenerator = keyGeneratorEntry.getValue();
<a class="jxr_linenumber" name="174" href="#174">174</a>             <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">KeyGeneratorMethodExecutor</a> keyGeneratorMethodExecutor = <strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">KeyGeneratorMethodExecutor</a>(keyGenerator);
<a class="jxr_linenumber" name="175" href="#175">175</a>             <strong class="jxr_keyword">this</strong>.keyGeneratorMethodExecutors.put(name, keyGeneratorMethodExecutor);
<a class="jxr_linenumber" name="176" href="#176">176</a>         }
<a class="jxr_linenumber" name="177" href="#177">177</a>     }
<a class="jxr_linenumber" name="178" href="#178">178</a> 
<a class="jxr_linenumber" name="179" href="#179">179</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * Create a new key generator with the specified name.</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="182" href="#182">182</a>     @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="183" href="#183">183</a>     <strong class="jxr_keyword">protected</strong> CacheKeyGenerator&lt;Serializable&gt; createKeyGenerator(
<a class="jxr_linenumber" name="184" href="#184">184</a>             String name, Class&lt;CacheKeyGenerator&lt;Serializable&gt;&gt; keyGeneratorClass,
<a class="jxr_linenumber" name="185" href="#185">185</a>             MutablePropertyValues properties) {
<a class="jxr_linenumber" name="186" href="#186">186</a>         
<a class="jxr_linenumber" name="187" href="#187">187</a>         <strong class="jxr_keyword">final</strong> AbstractBeanDefinition beanDefinition = <strong class="jxr_keyword">new</strong> GenericBeanDefinition();
<a class="jxr_linenumber" name="188" href="#188">188</a>         beanDefinition.setBeanClass(keyGeneratorClass);
<a class="jxr_linenumber" name="189" href="#189">189</a>         
<a class="jxr_linenumber" name="190" href="#190">190</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.reflectionHelper != <strong class="jxr_keyword">null</strong> &amp;&amp; ReflectionHelperAware.<strong class="jxr_keyword">class</strong>.isAssignableFrom(beanDefinition.getBeanClass())) {
<a class="jxr_linenumber" name="191" href="#191">191</a>             properties.addPropertyValue(<span class="jxr_string">"reflectionHelper"</span>, <strong class="jxr_keyword">this</strong>.reflectionHelper);
<a class="jxr_linenumber" name="192" href="#192">192</a>         }
<a class="jxr_linenumber" name="193" href="#193">193</a>         beanDefinition.setPropertyValues(properties);
<a class="jxr_linenumber" name="194" href="#194">194</a>         
<a class="jxr_linenumber" name="195" href="#195">195</a>         <strong class="jxr_keyword">this</strong>.cacheKeyBeanFactory.registerBeanDefinition(name, beanDefinition);
<a class="jxr_linenumber" name="196" href="#196">196</a>         
<a class="jxr_linenumber" name="197" href="#197">197</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.cacheKeyBeanFactory.getBean(name, CacheKeyGenerator.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="198" href="#198">198</a>     }
<a class="jxr_linenumber" name="199" href="#199">199</a>     
<a class="jxr_linenumber" name="200" href="#200">200</a>     <strong class="jxr_keyword">public</strong> Serializable generateKey(MethodInvocation methodInvocation) {
<a class="jxr_linenumber" name="201" href="#201">201</a>         <strong class="jxr_keyword">final</strong> Object[] arguments = methodInvocation.getArguments();
<a class="jxr_linenumber" name="202" href="#202">202</a>         
<a class="jxr_linenumber" name="203" href="#203">203</a>         <strong class="jxr_keyword">final</strong> EvaluationContext evaluationContext = <strong class="jxr_keyword">this</strong>.getEvaluationContext(methodInvocation, arguments);
<a class="jxr_linenumber" name="204" href="#204">204</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.expression.getValue(evaluationContext, Serializable.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="205" href="#205">205</a>     }
<a class="jxr_linenumber" name="206" href="#206">206</a> 
<a class="jxr_linenumber" name="207" href="#207">207</a>     <strong class="jxr_keyword">public</strong> Serializable generateKey(Object... data) {
<a class="jxr_linenumber" name="208" href="#208">208</a> 	    <strong class="jxr_keyword">final</strong> EvaluationContext evaluationContext = getEvaluationContext(<strong class="jxr_keyword">null</strong>, data);
<a class="jxr_linenumber" name="209" href="#209">209</a> 	    <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.expression.getValue(evaluationContext, Serializable.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="210" href="#210">210</a> 	}
<a class="jxr_linenumber" name="211" href="#211">211</a> 
<a class="jxr_linenumber" name="212" href="#212">212</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment">     * Parse the specified String into a SpEL Expression</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="215" href="#215">215</a>     <strong class="jxr_keyword">protected</strong> Expression parseExpression(String expression) {
<a class="jxr_linenumber" name="216" href="#216">216</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.expressionParser.parseExpression(expression);
<a class="jxr_linenumber" name="217" href="#217">217</a>     }
<a class="jxr_linenumber" name="218" href="#218">218</a> 
<a class="jxr_linenumber" name="219" href="#219">219</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment">     * Get the {@link EvaluationContext} to use to evaluate the configured {@link Expression}</em>
<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="222" href="#222">222</a>     <strong class="jxr_keyword">protected</strong> EvaluationContext getEvaluationContext(MethodInvocation methodInvocation, Object... args) {
<a class="jxr_linenumber" name="223" href="#223">223</a>         <strong class="jxr_keyword">final</strong> StandardEvaluationContext evaluationContext = <strong class="jxr_keyword">new</strong> StandardEvaluationContext();
<a class="jxr_linenumber" name="224" href="#224">224</a> 	    evaluationContext.setBeanResolver(<strong class="jxr_keyword">new</strong> BeanFactoryResolver(<strong class="jxr_keyword">this</strong>.beanFactory));
<a class="jxr_linenumber" name="225" href="#225">225</a> 	    evaluationContext.setVariable(<span class="jxr_string">"invocation"</span>, methodInvocation);
<a class="jxr_linenumber" name="226" href="#226">226</a> 	    evaluationContext.setVariable(<span class="jxr_string">"args"</span>, args);
<a class="jxr_linenumber" name="227" href="#227">227</a> 	    evaluationContext.setVariable(<span class="jxr_string">"key"</span>, keyCallbackObject);
<a class="jxr_linenumber" name="228" href="#228">228</a> 	    evaluationContext.addMethodResolver(<strong class="jxr_keyword">this</strong>.methodResolver);
<a class="jxr_linenumber" name="229" href="#229">229</a>         <strong class="jxr_keyword">return</strong> evaluationContext;
<a class="jxr_linenumber" name="230" href="#230">230</a>     }
<a class="jxr_linenumber" name="231" href="#231">231</a>     
<a class="jxr_linenumber" name="232" href="#232">232</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_javadoccomment">     * Special method resolver that uses the keys from the Map of registered key generators as method names. Allows</em>
<a class="jxr_linenumber" name="234" href="#234">234</a> <em class="jxr_javadoccomment">     * for easy access to various key generation schemes from within the SpEL Expression</em>
<a class="jxr_linenumber" name="235" href="#235">235</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="236" href="#236">236</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">KeyGeneratorMethodResolver</a> <strong class="jxr_keyword">implements</strong> MethodResolver {
<a class="jxr_linenumber" name="237" href="#237">237</a>         <strong class="jxr_keyword">public</strong> MethodExecutor resolve(EvaluationContext context, Object targetObject, String name, List&lt;TypeDescriptor&gt; argumentTypes) <strong class="jxr_keyword">throws</strong> AccessException {
<a class="jxr_linenumber" name="238" href="#238">238</a>             <em class="jxr_comment">//Only resolve methods for our fake callback object</em>
<a class="jxr_linenumber" name="239" href="#239">239</a>             <strong class="jxr_keyword">if</strong> (keyCallbackObject != targetObject) {
<a class="jxr_linenumber" name="240" href="#240">240</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="241" href="#241">241</a>             }
<a class="jxr_linenumber" name="242" href="#242">242</a>             
<a class="jxr_linenumber" name="243" href="#243">243</a>             <strong class="jxr_keyword">return</strong> keyGeneratorMethodExecutors.get(name);
<a class="jxr_linenumber" name="244" href="#244">244</a>         }
<a class="jxr_linenumber" name="245" href="#245">245</a>     }
<a class="jxr_linenumber" name="246" href="#246">246</a>     
<a class="jxr_linenumber" name="247" href="#247">247</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="248" href="#248">248</a> <em class="jxr_javadoccomment">     * {@link MethodExecutor} wrapper around a cache key generator that delegates to</em>
<a class="jxr_linenumber" name="249" href="#249">249</a> <em class="jxr_javadoccomment">     * {@link CacheKeyGenerator#generateKey(Object...)}</em>
<a class="jxr_linenumber" name="250" href="#250">250</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="251" href="#251">251</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">KeyGeneratorMethodExecutor</a> <strong class="jxr_keyword">implements</strong> MethodExecutor {
<a class="jxr_linenumber" name="252" href="#252">252</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> CacheKeyGenerator&lt;Serializable&gt; cacheKeyGenerator;
<a class="jxr_linenumber" name="253" href="#253">253</a> 
<a class="jxr_linenumber" name="254" href="#254">254</a>         <strong class="jxr_keyword">private</strong> <a href="../../../../../com/googlecode/ehcache/annotations/key/SpELCacheKeyGenerator.html">KeyGeneratorMethodExecutor</a>(CacheKeyGenerator&lt;Serializable&gt; cacheKeyGenerator) {
<a class="jxr_linenumber" name="255" href="#255">255</a>             <strong class="jxr_keyword">this</strong>.cacheKeyGenerator = cacheKeyGenerator;
<a class="jxr_linenumber" name="256" href="#256">256</a>         }
<a class="jxr_linenumber" name="257" href="#257">257</a> 
<a class="jxr_linenumber" name="258" href="#258">258</a>         <strong class="jxr_keyword">public</strong> TypedValue execute(EvaluationContext context, Object target, Object... arguments) <strong class="jxr_keyword">throws</strong> AccessException {
<a class="jxr_linenumber" name="259" href="#259">259</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> TypedValue(<strong class="jxr_keyword">this</strong>.cacheKeyGenerator.generateKey(arguments));
<a class="jxr_linenumber" name="260" href="#260">260</a>         }
<a class="jxr_linenumber" name="261" href="#261">261</a>     }
<a class="jxr_linenumber" name="262" href="#262">262</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

